home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / gui / bgui11b.lha / docs / propclass.doc < prev    next >
Encoding:
Text File  |  1994-08-18  |  2.5 KB  |  91 lines
  1.  
  2.            $RCSfile: propclass.doc,v $
  3.         Description: Propclass documentation.
  4.           Copyright: (C) Copyright 1994 Jaba Development.
  5.                      (C) Copyright 1994 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8.             $Author: jaba $
  9.           $Revision: 1.2 $
  10.               $Date: 1994/08/18 15:17:01 $
  11. ------------------------------------------------------------------------------
  12.  
  13. TABLE OF CONTENTS
  14.  
  15. propclass/--background--
  16. propclass/Methods
  17. propclass/Attributes
  18.  
  19. propclass/--background--                              propclass/--background--
  20.  
  21.     NAME
  22.         Class:          propclass
  23.         Superclass:     baseclass
  24.         Include File:   <libraries/bgui.h>
  25.  
  26.     FUNCTION
  27.         To  provide  a  BGUI compatible extention of the system propgclass. In
  28.         addition   to   the   normal  propgclass  functionality  you  get  the
  29.         possibility  to  add  arrow  gadgets  to the object. Objects from this
  30.         class sends out the following attribute pairs in notification events:
  31.  
  32.         GA_ID           - Gadget object ID.
  33.         PGA_Top         - Top position of the prop knob.
  34.  
  35. propclass/Methods                                            propclass/Methods
  36.  
  37.     NEW METHODS
  38.         None.
  39.  
  40.     CHANGED METHODS
  41.         None.
  42.  
  43. propclass/Attributes                                      propclass/Attributes
  44.  
  45.     NAME
  46.         PGA_Arrows -- ( BOOL )
  47.  
  48.     FUNCTION
  49.         To  determine  wether  or not the create object will get arrow gadgets
  50.         attached to the proportional gadget.
  51.  
  52.         Default is TRUE. Applicability is (I).
  53.  
  54.     SEE ALSO
  55.         PGA_ArrowSize
  56.  
  57.     NAME
  58.         PGA_ArrowSize -- ( ULONG )
  59.  
  60.     FUNCTION
  61.         To  determine  the size of the arrows. The size affected is the height
  62.         of  the  arrows in vertical prop objects or the width of the arrows in
  63.         horizontal prop objects.
  64.  
  65.         Defaults are 10 horizontal and 9 vertical. Applicability is (I).
  66.  
  67.     SEE ALSO
  68.         PGA_Arrows
  69.  
  70.     NAME
  71.         PGA_ThinFrame -- ( BOOL )
  72.  
  73.     FUNCTION
  74.         To make  all  sroller  object framing appear as thin frames. This will
  75.         help you to make an aspect-ratio dependant GUI.
  76.  
  77.         Default is FALSE. Applicability is (I).
  78.  
  79.     NAME
  80.         PGA_XenFrame -- ( BOOL )
  81.  
  82.     FUNCTION
  83.         To make all scroller object framing appear as Xen style framing.
  84.  
  85.         Default is FALSE. Applicability is (I).
  86.  
  87.     NOTE
  88.         All system propgclass attributes are also valid for this class. Please
  89.         refer  to  the documentation on the propgclass for more information on
  90.         these attributes.
  91.